/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/06
 * Time: 17:48
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.api.facading;

import kiwi.core.model.entity.KiWiFacade;
import kiwi.core.model.rdf.KiWiResource;

import java.util.Collection;

/**
 * Offers methods for loading and proxying KiWiFacades. A KiWi Facade is an interface that defines a Java
 * object with convenient Java methods around a KiWiResource and makes it possible to use RDF properties like
 * Java Bean properties from inside Java.
 * <p/>
 * The facading service is used by many other services, e.g. ContentItemService and TaggingService, to provide
 * access on a higher level than raw RDF resources.
 *
 *
 * <p/>
 * User: sschaffe
 */
public interface FacadingService {

    /**
     * Create an instance of C that facades the resource given as argument using the @RDF annotations provided
     * to the getter or setter methods of Cto map to properties of the resource in the triple store.
     *
     * @param r the resource to facade
     * @param type the facade type as a class
     * @param <C> the facade type as a generic parameter
     * @return
     */
    public <C extends KiWiFacade> C createFacade(KiWiResource r, Class<C> type);

    /**
     * Create a collection of instances of C that facade the resources given in the collection passed as argument.
     * The facade uses the @RDF annotations provided to the getter or setter methods of C. The returned collection
     * is of the same kind as the passed collection.
     *
     * @param list the collection containing the resources to facade
     * @param type the facade type as a class
     * @param <C> the facade type as a generic parameter
     * @return
     */
    public <C extends KiWiFacade> Collection<C> createFacade(Collection<KiWiResource> list, Class<C> type);

    /**
     * Create an instance of C that facades the resource identified by the uri given as argument, using the @RDF
     * annotations provided to the getter or setter methods of C to map to properties of the resource in the triple
     * store.
     *
     * @param uri the uri of the resource to facade
     * @param type the facade type as a class
     * @param <C> the facade type as a generic parameter
     * @return
     */
    public <C extends KiWiFacade> C createFacade(String uri, Class<C> type);


}
